Method: {...}

1: /*
2: * *********************************************************************************************************************
3: *
4: * TheseFoolishThings: Miscellaneous utilities
5: * http://tidalwave.it/projects/thesefoolishthings
6: *
7: * Copyright (C) 2009 - 2024 by Tidalwave s.a.s. (http://tidalwave.it)
8: *
9: * *********************************************************************************************************************
10: *
11: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
12: * the License. You may obtain a copy of the License at
13: *
14: * http://www.apache.org/licenses/LICENSE-2.0
15: *
16: * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
17: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations under the License.
19: *
20: * *********************************************************************************************************************
21: *
22: * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
23: * git clone https://github.com/tidalwave-it/thesefoolishthings-src
24: *
25: * *********************************************************************************************************************
26: */
27: package it.tidalwave.role.io;
28:
29: import javax.annotation.Nonnull;
30: import java.io.IOException;
31: import java.io.OutputStream;
32:
33: /***********************************************************************************************************************
34: *
35: * The role of an object that can be written as a stream of bytes.
36: *
37: * @stereotype Role
38: *
39: * @author Fabrizio Giudici
40: * @it.tidalwave.javadoc.stable
41: *
42: **********************************************************************************************************************/
43: @FunctionalInterface
44: public interface BinaryWritable
45: {
46: public static final Class<BinaryWritable> _BinaryWritable_ = BinaryWritable.class;
47:
48: /*******************************************************************************************************************
49: *
50: * A default implementation which throws {@link IOException} when opening the stream.
51: *
52: ******************************************************************************************************************/
53: public static final BinaryWritable DEFAULT = new BinaryWritable()
54: {
55: @Override @Nonnull
56: public OutputStream openStream()
57: throws IOException
58: {
59: throw new IOException("Operation not supported");
60: }
61: };
62:
63: /*******************************************************************************************************************
64: *
65: * Returns an {@link OutputStream} to write into the object.
66: *
67: * @return the {@code OutputStream}
68: * @throws IOException if the operation can't be performed
69: *
70: ******************************************************************************************************************/
71: @Nonnull
72: public OutputStream openStream()
73: throws IOException;
74: }